

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Enable Filter [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Debugger,Debugger Enable Filter, Options Tab,Debugger Filters,Debugger Wildcard in Filter,Enable Filter,Enable Filter Debugger Options Tab">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Enable Filter</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="sequence_tab_options.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="record_arguments_to_function_c.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">If the </span><span class="f_MenuKeyField">Enable Filter</span><span class="f_BodyText"> option is selected on the </span><span class="f_UIControl">Options</span><span class="f_BodyText"> tab, the debugger excludes calls to matching methods from the generated sequence history and diagram. The comparison is case-sensitive.</span></p>
<p class="p_BodyText"><span class="f_BodyText">To add a value, click on the </span><span class="f_MenuKeyField">New</span><span class="f_BodyText"> (Insert) icon in the right corner of the </span><span class="f_MenuKeyField">Filters</span><span class="f_BodyText"> box, and type in the comparison string. Each filter string takes the form:</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_Code"><span class="f_Code">class_name_token::method_name_token</span></p>
<p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">class_name_token</span><span class="f_BodyText"> excludes calls to all methods of a Class or Classes having a name that matches the token. The string can contain the wildcard character</span><span class="f_Code"> </span><span class="f_Code">*</span><span class="f_BodyText"> (asterisk). The token is optional.</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_BodyText" style="font-style: italic;">method_name_token</span><span class="f_BodyText"> excludes calls to methods having a name that matches token. The string can contain the wildcard character</span><span class="f_Code"> </span><span class="f_Code">*</span><span class="f_BodyText">. The token is optional.</span></p>
<p class="p_BodyText"><span class="f_BodyText">Where no Class token is present, the filter is applied only to global or public functions; that is, methods not belonging to any Class.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" bgcolor="#e3e6ed" style="width:449px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">To Filter</span></p>
</td>
<td valign="top" width="163" bgcolor="#e3e6ed" style="width:163px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use Filter Entry</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" style="width:449px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">All public functions having a name beginning with </span><span class="f_Tabletext" style="font-weight: bold;">Get</span><span class="f_Tabletext"> from the recording session (</span><span class="f_Tabletext" style="font-style: italic;">GetClientRect</span><span class="f_Tabletext"> for example in Windows API).</span></p>
</td>
<td valign="top" width="163" style="width:163px; border: solid 1px #000000;"><p class="p_Code"><span class="f_Code">&nbsp;</span><br>
<span class="f_Code">::Get*</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" style="width:449px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">All methods beginning with</span><span class="f_Tabletext" style="font-weight: bold;"> Get</span><span class="f_Tabletext"> for every Class member method.</span></p>
</td>
<td valign="top" width="163" style="width:163px; border: solid 1px #000000;"><p class="p_Code"><span class="f_Code">&nbsp;</span><br>
<span class="f_Code">*::Get*</span><br>
<span class="f_Code">&nbsp;</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" style="width:449px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">All methods beginning with </span><span class="f_Tabletext" style="font-weight: bold;">Get</span><span class="f_Tabletext"> from the Class </span><span class="f_Tabletext" style="font-style: italic;">CClass.</span></p>
</td>
<td valign="top" width="163" style="width:163px; border: solid 1px #000000;"><p class="p_Code"><span class="f_Code">&nbsp;</span><br>
<span class="f_Code">CClass::Get*</span><br>
<span class="f_Code">&nbsp;</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" style="width:449px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">All methods for Class </span><span class="f_Tabletext" style="font-style: italic;">CClass</span><span class="f_Tabletext">.</span></p>
</td>
<td valign="top" width="163" style="width:163px; border: solid 1px #000000;"><p class="p_Code"><span class="f_Code">&nbsp;</span><br>
<span class="f_Code">CClass::*</span><br>
<span class="f_Code">&nbsp;</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" style="width:449px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">All methods for Classes belonging to Standard Template and Active Template Libraries.</span></p>
</td>
<td valign="top" width="163" style="width:163px; border: solid 1px #000000;"><p class="p_Code"><span class="f_Code">&nbsp;</span></p>
<ul style="text-indent: 0px; margin-left: 40px; list-style-position: outside;">
<li><span class="f_Code">ATL*</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 40px; list-style-position: outside;">
<li><span class="f_Code">std*</span><br>
<span class="f_Code">&nbsp;</span></li>
</ul>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="449" style="width:449px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">The specific method </span><span class="f_Tabletext" style="font-style: italic;">GetName</span><span class="f_Tabletext"> for Class </span><span class="f_Tabletext" style="font-style: italic;">CClass.</span></p>
</td>
<td valign="top" width="163" style="width:163px; border: solid 1px #000000;"><p class="p_Code"><span class="f_Code">&nbsp;</span><br>
<span class="f_Code">CClass::GetName</span><br>
<span class="f_Code">&nbsp;</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">&nbsp;</span></p>
<p class="p_BodyText"><span class="f_BodyText">In the Java example in the screen below, the debugger would exclude:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Calls to </span><span class="f_Bulletlist1" style="font-style: italic;">OnDraw</span><span class="f_Bulletlist1"> method for Class </span><span class="f_Bulletlist1" style="font-style: italic;">Example.common.draw.DrawPane</span></li>
<li><span class="f_Bulletlist1">Calls to any method of any Class having a name beginning with </span><span class="f_Bulletlist1" style="font-style: italic;">Example.source.Collection</span></li>
<li><span class="f_Bulletlist1">Calls to any constructor for any Class (ie: </span><span class="f_Bulletlist1" style="font-style: italic;">&lt;clint&gt;</span><span class="f_Bulletlist1"> and </span><span class="f_Bulletlist1" style="font-style: italic;">&lt;init&gt;</span><span class="f_Bulletlist1">).</span></li>
</ul>
<p class="p_TextIndentedL2"><img src="java_filters.png" width="681" height="316" border="0" alt="java_filters"></p>
<p class="p_BodyText"><span class="f_BodyText">In the Native code example below, the debugger would exclude:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1">Calls made to Standard Template Library namespace</span></li>
<li><span class="f_Bulletlist1">Calls to any Class beginning with </span><span class="f_Bulletlist1" style="font-weight: bold;">TOb</span></li>
<li><span class="f_Bulletlist1">Calls to any method of Class </span><span class="f_Bulletlist1" style="font-style: italic;">CLock</span></li>
<li><span class="f_Bulletlist1">Calls to any Global or Public Function with a name beginning with </span><span class="f_Bulletlist1" style="font-weight: bold;">Get</span></li>
<li><span class="f_Bulletlist1">Calls to the method </span><span class="f_Bulletlist1" style="font-style: italic;">GetLocation</span><span class="f_Bulletlist1"> for Class </span><span class="f_Bulletlist1" style="font-style: italic;">Ctrain.</span></li>
</ul>
<p class="p_TextIndentedL2"><img src="filters_native.png" width="682" height="316" border="0" alt="Filters_Native"></p>




            </div>
          </div>
        </div>



</div>


</body>
</html>
